IApi.ReadAxisInputs method

Reads a value from an input of an axis.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB
KsReturn<uint> ReadAxisInputs(
       int Index
)
Function ReadAxisInputs(
       Index As Integer
) As KsReturn(Of UInteger)

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Return value

Type: KsReturn<uint>

Returns a KsError code and an unsigned integer value.

Remarks

Used in the cyclic callback to check the digital inputs of an axis.

NOTE:  The digital input is available only if EnableAxisInput is enabled.

Usable EtherCAT states

ecatOP

Examples

C#
N/A

See also

IApi Interface

IntervalZero.KINGSTAR.Base.Api Namespace